2017-09-01 03:25:47 +00:00
|
|
|
[[_upgrade_adapters]]
|
|
|
|
|
|
|
|
|
|
It is important that you upgrade {project_name} server first, and then upgrade the adapters. Earlier versions of the
|
|
|
|
|
adapter might work with later versions of {project_name} server, but earlier versions of {project_name} server might not
|
|
|
|
|
work with later versions of the adapter.
|
|
|
|
|
|
2018-01-22 09:57:03 +00:00
|
|
|
[[_compatibility_with_older_adapters]]
|
|
|
|
|
== Compatibility with older adapters
|
|
|
|
|
|
|
|
|
|
As mentioned above, we try to support newer release versions of {project_name} server working with older release versions of the adapters.
|
|
|
|
|
However, in some cases we need to include fixes on the {project_name} server side which may break compatibility with older versions
|
|
|
|
|
of the adapters. For example, when we implement new aspects of the OpenID Connect specification, which older client adapter versions
|
|
|
|
|
were not aware of.
|
|
|
|
|
|
|
|
|
|
In those cases, we added Compatibility modes. For OpenId Connect clients, there is a section named `OpenID Connect Compatibility Modes`
|
|
|
|
|
in the {project_name} admin console, on the page with client details. Here, you can disable some new aspects of the {project_name} server
|
|
|
|
|
to preserve compatibility with older client adapters. More details are available in the tool tips of individual switches.
|
|
|
|
|
|
2017-09-01 03:25:47 +00:00
|
|
|
|
|
|
|
|
[[_upgrade_eap_adapter]]
|
|
|
|
|
== Upgrading the EAP Adapter
|
|
|
|
|
|
|
|
|
|
To upgrade the {appserver_name} adapter, complete the following steps:
|
|
|
|
|
|
|
|
|
|
. Download the new adapter archive.
|
|
|
|
|
. Remove the previous adapter modules by deleting the `{appserver_dirref}/modules/system/add-ons/keycloak/` directory.
|
|
|
|
|
. Unzip the downloaded archive into {appserver_dirref}.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[[_upgrade_js_adapter]]
|
|
|
|
|
== Upgrading the JavaScript Adapter
|
|
|
|
|
|
|
|
|
|
To upgrade a JavaScript adapter that has been copied to your web application, complete the following steps:
|
|
|
|
|
|
|
|
|
|
. Download the new adapter archive.
|
|
|
|
|
. Overwrite the keycloak.js file in your application with the keycloak.js file from the downloaded archive.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[[_upgrade_nodejs_adapter]]
|
|
|
|
|
== Upgrading the Node.js Adapter
|
|
|
|
|
|
|
|
|
|
To upgrade a Node.js adapter that has been copied to your web application, complete the following steps:
|
|
|
|
|
|
|
|
|
|
. Download the new adapter archive.
|
|
|
|
|
. Remove the existing Node.js adapter directory
|
|
|
|
|
. Unzip the updated file into its place
|
|
|
|
|
. Change the dependency for keycloak-connect in the package.json of your application
|
