Skip to content

Mihai-B/keycloak-arm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 

Repository files navigation

Keycloak Docker image

docker hub: Docker Pulls
buy me a coffe: Buy a coffe

Available Keycloak versions

Starting with version 15.0.1 of Keycloak, only ARM 64 is supported by this repo
Starting from version 17 onwards images with legacy tag represent the old Keycloak with jboss support. Ther ones that do not have the legacy keyword are the ones that use the new Quarkus implementation(aka server-x as Keycloak refer to this new implementation)

ARM

10.x: 10.0.2
11.x: 11.0.0, 11.0.1, 11.0.2, 11.0.3
12.x: 12.0.1, 12.0.2, 12.0.4
13.x: 13.0.0, 13.0.1
14.x: 14.0.0

ARM 64

15.x: 15.0.1
17.x-legacy: 17.0.0-legacy, 17.0.1-legacy
18.x-legacy: 18.0.0-legacy, 18.0.2-legacy
18.x: -might release a version with server-x support-

How the image is build

For ARM 64 the default image as shipped by Keycloak are used, no modifications are made.

For ARM version, this image uses the official Keycloak repository that is used to build the official Keycloak image. The only difference is that the Dockerfile used to build the official version of Keycloak is changed with the one from this repository and the image is build on a Raspberry Pi 3 (32 bit)

The docker image has to be changed when building the ARM version of Keycloak because the base image that is used by Keycloak does not support ARM processors thus it is swapped with Ubuntu as base image

How to use

Quick start Keycloak using MySql/MariaDb

First run

docker run -p 9877:8080 --name keycloak -e KEYCLOAK_USER=<KEYCLOAK_USER> -e KEYCLOAK_PASSWORD=<KEYCLOAK_PASSWORD>  -e DB_VENDOR=<DB_VENDOR> -e DB_ADDR=<DB_ADDR> -e DB_DATABASE=<DB_DATABASE> -e DB_USER=<DB_USER> -e DB_PASSWORD=<DB_PASSWORD> -e JDBC_PARAMS: "serverTimezone=UTC" mihaibob/keycloak:<KEYCLOAK_VERSION>

In this example Keycloak will be available on port 9877.
The variables need to be changed acordingly:
KEYCLOAK_USER - the username you want to use for Keycloak's admin user
KEYCLOAK_PASSWORD - the password for Keycloak's admin user
DB_VENDOR - the database vendor, can be any of: h2, mysql, mariadb, postgres, oracle, mssql
DB_ADDR - where the database can be accessed, example: 192.168.1.10. Do not use 'localhost' even if the database is on the same board
DB_DATABASE - the database keycloak should create the tables in(make sure the database is allready created)
DB_USER - the user that keycloak should use to access the database
DB_PASSWORD - the password keycloak should use to access the database
KEYCLOAK_VERSION - the Keycloak version to run

Upgrading Keycloak container to a later version

After Keycloak was run using the 'First run' command, and an upgrade is in order then the command to start Keycloak should look like this:

docker run -p 9877:8080 -d --name keycloak -e DB_VENDOR=mysql -e DB_ADDR=<DB_ADDR> -e DB_DATABASE=<DB_DATABASE> -e DB_USER=<DB_USER> -e DB_PASSWORD=<DB_PASSWORD> -e JDBC_PARAMS: "serverTimezone=UTC" mihaibob/keycloak:<KEYCLOAK_VERSION>

Notice we did not specify the 'KEYCLOAK_USER' and 'KEYCLOAK_PASSWORD' since they are saved in the database now

Full documentation

For a complete documentation refer to Keycloak's official documentation on how to configure the docker container because the process is exactly the same. The documentation can be found here.