Skip to content

Updating Keycloak

Requirements

  • internet access for downloading the zip file from the SEAL Systems delivery platform

Updating from Version 1.0.1

Hint - internal data structure changes

Due to Keycloak internal data structure changes you have to export the configuration before updating, then delete the existing configuration and reimport the exported configuration afterwards.

  1. In a browser, log on to the SEAL Systems delivery platform with your logon data:

    https://delivery.sealsystems.de

    Hint - logon data

    You receive the logon data from your Technical Project Manager at SEAL Systems.

  2. Download the Keycloak - 15.0.0.18 - msi folder. It is saved as Keycloak - 15.0.0.18 - msi.zip.

  3. Export the Keycloak configuration:

    For details on the exporting, see Keycloak documentation.

  4. In a PowerShell (Administrator), stop the service:

    service-stop seal-keycloak

  5. Remove the content of the %ProgramData%\SEAL Systems\data\seal-keycloak\ directory:

    Remove-Item "%ProgramData%\SEAL Systems\data\seal-keycloak\*" -Force -Recurse

  6. Change to the download directory and start installing the package:

    install.ps1

  7. In the %ProgramData%\SEAL Systems\data\seal-keycloak\configuration\standalone.xml file, remove all lines referring to SmallRye modules, particularly the following lines:

    <extension module="org.wildfly.extension.microprofile.config-smallrye"/>
<extension module="org.wildfly.extension.microprofile.health-smallrye"/>
<extension module="org.wildfly.extension.microprofile.metrics-smallrye"/>

<subsystem xmlns="urn:wildfly:microprofile-config-smallrye:1.0"/>
<subsystem xmlns="urn:wildfly:microprofile-health-smallrye:2.0" security-enabled="false" empty-liveness-checks-status="${env.MP_HEALTH_EMPTY_LIVENESS_CHECKS_STATUS:UP}" empty-readiness-checks-status="${env.MP_HEALTH_EMPTY_READINESS_CHECKS_STATUS:UP}"/>
<subsystem xmlns="urn:wildfly:microprofile-metrics-smallrye:2.0" security-enabled="false" exposed-subsystems="*" prefix="${wildfly.metrics.prefix:wildfly}"/>

    For details on the migration, see Keycloak upgrading guide.

  8. Import the previously exported Keycloak configuration:

    For details on the importing, see Keycloak documentation.

  9. Restart the service:

    service-start seal-keycloak

Updating from Version 6.0.1.99

Hint - changed data directory

With version 6.0.1.99 the data directory changes to C:\ProgramData\SEAL Systems\data\seal-keycloak. Therefore the update requires different steps depending on your current version of Keycloak:

  1. In a browser, log on to the SEAL Systems delivery platform with your logon data:

    https://delivery.sealsystems.de

    Hint - logon data

    You receive the logon data from your Technical Project Manager at SEAL Systems.

  2. Download the Keycloak - 15.0.0.18 - msi folder. It is saved as Keycloak - 15.0.0.18 - msi.zip.

  3. In a PowerShell (Administrator), change to the download directory and start installing the package:

    install.ps1

  4. Stop the service:

    service-stop seal-keycloak

  5. In the %ProgramData%\SEAL Systems\data\seal-keycloak\configuration\standalone.xml file, remove all lines referring to SmallRye modules, particularly the following lines:

    <extension module="org.wildfly.extension.microprofile.config-smallrye"/>
<extension module="org.wildfly.extension.microprofile.health-smallrye"/>
<extension module="org.wildfly.extension.microprofile.metrics-smallrye"/>

<subsystem xmlns="urn:wildfly:microprofile-config-smallrye:1.0"/>
<subsystem xmlns="urn:wildfly:microprofile-health-smallrye:2.0" security-enabled="false" empty-liveness-checks-status="${env.MP_HEALTH_EMPTY_LIVENESS_CHECKS_STATUS:UP}" empty-readiness-checks-status="${env.MP_HEALTH_EMPTY_READINESS_CHECKS_STATUS:UP}"/>
<subsystem xmlns="urn:wildfly:microprofile-metrics-smallrye:2.0" security-enabled="false" exposed-subsystems="*" prefix="${wildfly.metrics.prefix:wildfly}"/>

    For details on the migration, see Keycloak upgrading guide.

  6. Restart the service:

    service-start seal-keycloak

Updating from Previous Versions

  1. In a browser, log on to the SEAL Systems delivery platform with your logon data:

    https://delivery.sealsystems.de

    Hint - logon data

    You receive the logon data from your Technical Project Manager at SEAL Systems.

  2. Download the Keycloak - 15.0.0.18 - msi folder. It is saved as Keycloak - 15.0.0.18 - msi.zip.

  3. Open a Command Prompt (Adminstrator).

  4. Stop the service:

    net stop seal-keycloak

  5. Move the seal-keycloak data directory with the following command:

    robocopy "%ProgramData%\SEAL Systems\data\seal-keycloak" "%ProgramData%\SEAL Systems\data\seal-keycloak" * /e /b /copyall /move /fp /ns /nc /np /nfl /ndl

  6. Uninstall the old version.

  7. Change to the download directory and start installing the package:

    install.ps1

  8. After the installation is finished, start the service:

    service-start seal-keycloak
Back to top