Skip to content

Commit

Permalink
Fix outdated keycloak docker image (#10908)
Browse files Browse the repository at this point in the history
* Change Docker Image from jboss image to the actual keycloak image since jboss image is not maintained anymore
* Update image with the same image and version from the Docker Compose Project
* Add msg about outdated keycloak docs

---------

Co-authored-by: Ugur Köysüren <ukoysuren@Mac-Studio-von-Ugur.fritz.box>
Co-authored-by: Ino de Bruijn <ino@ino.bio>
  • Loading branch information
3 people authored Aug 27, 2024
1 parent 64753c7 commit 229c01f
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/deployment/docker/using-keycloak.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Authenticating and Authorizing Users using Keycloak in Docker

**⚠️ This documentation for keycloak might be outdated, see related [ticket](https://github.com/cBioPortal/cbioportal/issues/10360) ⚠️**

This guide describes a way to Dockerise Keycloak along with cBioPortal, for authentication.

First, create an isolated network in which the Keycloak and MySQL servers can talk to one another.
Expand All @@ -22,7 +24,7 @@ docker run -d --restart=always \
mysql:5.7
```

Then run the actual Keycloak server, using [this image](https://hub.docker.com/r/jboss/keycloak/) available from Docker Hub. This will by default connect to the database using the (non-root) credentials in the example above. The server will be accessible to the outside world on port 8180, so make sure to choose a strong administrator password.
Then run the actual Keycloak server, using [this image](https://quay.io/repository/keycloak/keycloak) available from Red Hat Image Registry Quay.io. This will by default connect to the database using the (non-root) credentials in the example above. The server will be accessible to the outside world on port 8180, so make sure to choose a strong administrator password.

The command below uses the default values for `MYSQL_DATABASE`, `MYSQL_USER` and `MYSQL_PASSWORD` (listed in the command above). If you wish to change these credentials, specify them in the command below. For instance, if `MYSQL_USER` in the database container is `user`, you need to add `-e MYSQL_USER=user`.

Expand All @@ -35,7 +37,7 @@ docker run -d --restart=always \
-e DB_ADDR=kcdb \
-e KEYCLOAK_USER=admin \
-e "KEYCLOAK_PASSWORD=<admin_password_here>" \
jboss/keycloak:4.8.3.Final
quay.io/keycloak/keycloak:16.1.1
```

Finally, configure Keycloak and cBioPortal as explained in the [Keycloak documentation](./../authorization-and-authentication/Authenticating-and-Authorizing-Users-via-keycloak.md). Remember to specify port 8180 for the Keycloak server, wherever the guide says 8080.
Expand Down

0 comments on commit 229c01f

Please sign in to comment.