feat!: new 20.x release

[ci skip]

.env.sample

@@ -6,9 +6,7 @@ DOMAIN=keycloak.example.com
 LETS_ENCRYPT_ENV=production
 
 ADMIN_USERNAME=admin
-
+WELCOME_THEME=keycloak
-# CUSTOM_THEME_ENABLED=1
-# CUSTOM_THEME_URL=
 
 SECRET_DB_ROOT_PASSWORD_VERSION=v1
 SECRET_DB_PASSWORD_VERSION=v1

README.md

@@ -6,12 +6,12 @@
 
 <!-- metadata -->
 * **Category**: Apps
-* **Status**: ❷💛
+* **Status**: 2, beta
-* **Image**: [`jboss/keycloak`](https://hub.docker.com/r/jboss/keycloak), ❶💚, upstream
+* **Image**: [`jboss/keycloak`](https://hub.docker.com/r/jboss/keycloak), 4, upstream
 * **Healthcheck**: Yes
 * **Backups**: ?
-* **Email**: ❸🍎
+* **Email**: 1
-* **Tests**: ❷💛
+* **Tests**: 2
 * **SSO**: N/A
 <!-- endmetadata -->
 
@@ -25,5 +25,22 @@
    your Docker swarm box
 5. `abra app YOURAPPDOMAIN deploy`
 
+## How do I setup a custom theme?
+
+Check [this approach](https://git.autonomic.zone/ruangrupa/login.lumbung.space).
+
+## How do I create another admin user?
+
+- Under the `Master` realm > `Users` > `Add user`
+- Create the user and set a temporary password
+- Under the `Role Mappings` tab, move `admin` from `Available Roles` into `Assigned Roles`
+
+## How do I configure Keycloak login for..
+
+- [Nextcloud][nextcloud]
+- [Peertube][peertube]
+
+[nextcloud]: https://git.coopcloud.tech/coop-cloud/nextcloud
+[peertube]: https://git.coopcloud.tech/coop-cloud/peertube
 [abra]: https://git.autonomic.zone/autonomic-cooperative/abra
 [cc-traefik]: https://git.autonomic.zone/coop-cloud/traefik

abra.sh

@@ -1 +0,0 @@
-export ENTRYPOINT_CONF_VERSION=v1

compose.yml

@@ -3,7 +3,9 @@ version: "3.8"
 
 services:
   app:
-    image: "jboss/keycloak:15.0.2"
+    image: "keycloak/keycloak:20.0.1"
+    entrypoint: >
+      bash -c "KC_DB_PASSWORD=\"$$(cat /run/secrets/db_password)\" /opt/keycloak/bin/kc.sh start"
     networks:
       - proxy
       - internal
@@ -11,27 +13,22 @@ services:
       - admin_password
       - db_password
     environment:
-      - CUSTOM_THEME_ENABLED
+      - KC_DB=mariadb
-      - CUSTOM_THEME_URL
+      - KC_DB_URL_DATABASE=keycloak
-      - DB_ADDR=db
+      - KC_DB_URL_HOST=db
-      - DB_DATABASE=keycloak
+      - KC_HOSTNAME=${DOMAIN}
-      - DB_PASSWORD_FILE=/run/secrets/db_password
+      - KC_PROXY=edge
-      - DB_USER=keycloak
+      - KC_SPI_CONNECTIONS_JPA_LEGACY_MIGRATION_STRATEGY=update
-      - DB_VENDOR=mariadb
+      - KEYCLOAK_ADMIN=${ADMIN_USERNAME}
-      - KEYCLOAK_PASSWORD_FILE=/run/secrets/admin_password
+      - KEYCLOAK_WELCOME_THEME=${WELCOME_THEME}
-      - KEYCLOAK_USER=${ADMIN_USERNAME}
-      - PROXY_ADDRESS_FORWARDING=true
-    configs:
-      - source: entrypoint_conf
-        target: /docker-entrypoint.sh
-        mode: 0555
-    entrypoint: /docker-entrypoint.sh
     healthcheck:
       test: ["CMD", "curl", "-f", "http://localhost:8080"]
       interval: 30s
       timeout: 10s
       retries: 10
       start_period: 1m
+    volumes:
+      - "themes:/opt/jboss/keycloak/themes"
     depends_on:
       - mariadb
     deploy:
@@ -47,7 +44,7 @@ services:
         - "traefik.http.routers.${STACK_NAME}.middlewares=${STACK_NAME}-redirect"
         - "traefik.http.middlewares.${STACK_NAME}-redirect.headers.SSLForceHost=true"
         - "traefik.http.middlewares.${STACK_NAME}-redirect.headers.SSLHost=${DOMAIN}"
-        - "coop-cloud.${STACK_NAME}.version=3.0.0+15.0.2"
+        - "coop-cloud.${STACK_NAME}.version=5.0.0+20.0.1"
 
   db:
     image: "mariadb:10.6"
@@ -63,6 +60,12 @@ services:
       - "mariadb:/var/lib/mysql"
     networks:
       - internal
+    deploy:
+      labels:
+          backupbot.backup: "true"
+          backupbot.backup.pre-hook: 'mkdir -p /tmp/backup/ && mysqldump --single-transaction -u root -p"$$(cat /run/secrets/db_root_password)" keycloak > /tmp/backup/backup.sql'
+          backupbot.backup.post-hook: "rm -rf /tmp/backup"
+          backupbot.backup.path: "/tmp/backup/"
 
 networks:
   internal:
@@ -82,9 +85,4 @@ secrets:
 
 volumes:
   mariadb:
-
+  themes:
-configs:
-  entrypoint_conf:
-    name: ${STACK_NAME}_entrypoint_conf_${ENTRYPOINT_CONF_VERSION}
-    file: entrypoint.sh.tmpl
-    template_driver: golang

entrypoint.sh.tmpl

@@ -1,12 +0,0 @@
-#!/bin/bash
-
-set -e
-
-{{ if eq (env "CUSTOM_THEME_ENABLED") "1" }}
-microdnf update && microdnf install git
-git clone "$CUSTOM_THEME_URL" "/opt/jboss/keycloak/themes/$CUSTOM_THEME_NAME"
-{{ end }}
-
-# upstream entrypoint
-# https://github.com/keycloak/keycloak-containers/blob/aa2e5515ccb05116e49ab38839d8fcfdd17c45aa/server/Dockerfile#L30
-/usr/local/bin/entrypoint.sh "$@"

release/4.0.0+16.1.0

@@ -0,0 +1,12 @@
+This major release comes with a blog post about a CVE:
+
+    https://www.keycloak.org/2021/12/cve.html
+
+Not all versions are affected but they're suggesting that people upgrade soon.
+
+As per usual, this upgrade didn't go too smoothly and I ended up having to
+undeploy and deploy the new versions. The healtcheck kept failing on the new
+instance when trying to deploy alongside the existing old version. Idk, some
+docker weirdness.
+
+No app data errors discovered after upgrade.

release/5.0.0+20.0.1

@@ -0,0 +1,9 @@
+You'll need to remove `/auth/` from your app SSO URLs, e.g.
+
+    https://foo.example.com/auth/realms/foo/protocol/openid-connect/auth
+
+Would become:
+
+    https://foo.example.com/realms/foo/protocol/openid-connect/auth
+
+-- decentral1se @ Autonomic