Clarify Gatekeeper encryption key must be 16 or 32 characters long

EOEPCA · Mar 20, 2024 · c0f3ae2 · c0f3ae2
1 parent 42d3c68
commit c0f3ae2
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/docs/index.md b/docs/index.md
@@ -6,6 +6,7 @@
 
     The following provides a summary of changes since the last release (v1.4)...
 
+    * **20/03/2024** - Clarify Gatekeeper encryption key must be 16 or 32 characters long
     * **19/03/2024** - ADES stage-out fix (partial) for cwl workflow outputs of type Directory[] - e.g. `snuggs` sample app
     * **15/03/2024** - Update Application Hub to chart version `2.0.59` to add support for path-prefix (`BASE_URL`)
     * **08/03/2024** - Update Application Hub to chart version `2.0.58` to fix hard-coded namespace `proc`<br>

diff --git a/docs/quickstart/scripted-deployment.md b/docs/quickstart/scripted-deployment.md
@@ -55,7 +55,7 @@ The script [`deploy/eoepca/eoepca.sh`](https://github.com/EOEPCA/deployment-guid
     **IDENTITY_SERVICE_ADMIN_CLIENT** | The Keycloak client to use for admin API tasks during scripted deployment | `admin-cli`
     **IDENTITY_POSTGRES_PASSWORD** | The password for the Keycloak Postgres service | `${IDENTITY_SERVICE_DEFAULT_SECRET}`
     **IDENTITY_GATEKEEPER_CLIENT_SECRET** | The secret used for each Keycloak client (one per resource service) created during scripted deployment | `${IDENTITY_SERVICE_DEFAULT_SECRET}`
-    **IDENTITY_GATEKEEPER_ENCRYPTION_KEY** | The encryption key for each Keycloak client (one per resource service) created during scripted deployment | `changemechangeme`
+    **IDENTITY_GATEKEEPER_ENCRYPTION_KEY** | The encryption key for each Keycloak client (one per resource service) created during scripted deployment<br>NOTE that this must be either 16 or 32 characters long | `changemechangeme`
     **IDENTITY_REALM** | Keycloak realm for Identity Service.<br>_This is not explicitly created by the scripted deployment, and so is assumed to exist within the Keycloak instance. Thus, will probably break the deployment if modified._ | `master`
     **MINIO_ROOT_USER** | Name of the 'root' user for the Minio object storage service. | `eoepca`
     **MINIO_ROOT_PASSWORD** | Password for the 'root' user for the Minio object storage service. | `changeme`