Keycloak

1
= Upgrading {project_name} adapters
2

3
[[_upgrade_adapters]]
4

5
It is important that you upgrade {project_name} server first, and then upgrade the adapters. Earlier versions of the
6
adapter might work with later versions of {project_name} server, but earlier versions of {project_name} server might not
7
work with later versions of the adapter.
8

9
[[_compatibility_with_older_adapters]]
10
== Compatibility with older adapters
11

12
As mentioned above, we try to support newer release versions of {project_name} server working with older release versions of the adapters.
13
However, in some cases we need to include fixes on the {project_name} server side which may break compatibility with older versions
14
of the adapters. For example, when we implement new aspects of the OpenID Connect specification, which older client adapter versions
15
were not aware of.
16

17
In those cases, we added Compatibility modes. For OpenId Connect clients, there is a section named `OpenID Connect Compatibility Modes`
18
in the {project_name} admin console, on the page with client details. Here, you can disable some new aspects of the {project_name} server
19
to preserve compatibility with older client adapters. More details are available in the tool tips of individual switches.
20

21
[[_upgrade_eap_adapter]]
22
== Upgrading the EAP adapter
23

24
ifeval::[{project_product}==true]
25

26
.Procedure
27
If you originally installed the adapter using a downloaded archive, to upgrade the {appserver_name} adapter, perform the following procedure.
28

29
. Download the new adapter archive.
30
. Remove the previous adapter modules by deleting the `{appserver_dirref}/modules/system/add-ons/keycloak/` directory.
31
. Unzip the downloaded archive into `{appserver_dirref}`.
32

33
.Procedure
34
If you originally installed the adapter using RPM, to upgrade the adapter, complete the following steps, which are different depending on whether you are performing a minor or a micro upgrade:
35

36
. For minor upgrades, use Yum to uninstall any adapters you currently have installed and then use Yum to install the new version of the adapters.
37
. For micro upgrades, use Yum to upgrade the adapter. This is the only step for micro upgrades.
38
+
39
[source,bash,options="nowrap"]
40
----
41
yum update
42
----
43

44
endif::[]
45

46
ifeval::[{project_community}==true]
47

48
.Procedure
49
To upgrade the {appserver_name} adapter, complete the following steps:
50

51
. Download the new adapter archive.
52
. Remove the previous adapter modules by deleting the `{appserver_dirref}/modules/system/add-ons/keycloak/` directory.
53
. Unzip the downloaded archive into `{appserver_dirref}`.
54

55
endif::[]
56

57
[[_upgrade_js_adapter]]
58
== Upgrading the JavaScript adapter
59

60
To upgrade a JavaScript adapter that has been copied to your web application, perform the following procedure.
61

62
.Procedure
63

64
. Download the new adapter archive.
65
. Overwrite the keycloak.js file in your application with the keycloak.js file from the downloaded archive.
66

67
[[_upgrade_nodejs_adapter]]
68
== Upgrading the Node.js adapter
69

70
To upgrade a Node.js adapter that has been copied to your web application, perform the following procedure.
71

72
.Procedure
73
. Download the new adapter archive.
74
. Remove the existing Node.js adapter directory
75
. Unzip the updated file into its place
76
. Change the dependency for keycloak-connect in the package.json of your application
77