[sso] Allow for Keycloak login footer customisation

This enables more advanced customisation by allowing for
administrators to fully replace the footer of the login theme.

We try to take into account maintainability, at the same time mention
that it is the administrators' responsibility to keep their
customisations compatible with newer versions of DD.
GON-3874-DD-moodle
Evilham 2022-11-10 17:02:46 +01:00
parent 75e314ff7e
commit b92dc23557
No known key found for this signature in database
GPG Key ID: AE3EE30D970886BF
8 changed files with 68 additions and 7 deletions

1
.gitignore vendored
View File

@ -9,6 +9,7 @@ docs.built/
.env .env
dd-sso/docker/api/src/api/static/templates/*.html dd-sso/docker/api/src/api/static/templates/*.html
dd-sso/docker/api/src/api/static/templates/*.json dd-sso/docker/api/src/api/static/templates/*.json
dd-sso/docker/keycloak/themes/dd-custom
.idea/ .idea/
*.log *.log
# External, unmodified files # External, unmodified files

View File

@ -31,6 +31,7 @@ services:
- ${BUILD_SSO_ROOT_PATH}/init/keycloak/jsons:/opt/jboss/keycloak/imports - ${BUILD_SSO_ROOT_PATH}/init/keycloak/jsons:/opt/jboss/keycloak/imports
- ${BUILD_SSO_ROOT_PATH}/init/keycloak/scripts/:/opt/jboss/startup-scripts/ - ${BUILD_SSO_ROOT_PATH}/init/keycloak/scripts/:/opt/jboss/startup-scripts/
- ${CUSTOM_PATH}/custom/img:/opt/jboss/keycloak/themes/dd/login/resources/custom-img - ${CUSTOM_PATH}/custom/img:/opt/jboss/keycloak/themes/dd/login/resources/custom-img
- ${BUILD_SSO_ROOT_PATH}/docker/keycloak/themes/dd-custom:/opt/jboss/keycloak/themes/dd-custom
- ${BUILD_SSO_ROOT_PATH}/docker/keycloak/extensions/avatar-minio-extension-bundle-1.0.1.0-SNAPSHOT.ear:/opt/jboss/keycloak/standalone/deployments/avatar-minio-extension-bundle-1.0.1.0-SNAPSHOT.ear - ${BUILD_SSO_ROOT_PATH}/docker/keycloak/extensions/avatar-minio-extension-bundle-1.0.1.0-SNAPSHOT.ear:/opt/jboss/keycloak/standalone/deployments/avatar-minio-extension-bundle-1.0.1.0-SNAPSHOT.ear
environment: environment:
- AVATARS_SERVER_URL=http://dd-sso-avatars:9000 - AVATARS_SERVER_URL=http://dd-sso-avatars:9000

View File

@ -0,0 +1,31 @@
<footer id="page-footer">
<div class="container2">
<div class="footer-desc">
<div class="footer-desc-logo">
<img class="footer-desc-logo-img" src="${url.resourcesPath}/img/logo_icon.svg" style=""/>
</div>
<div class="footer-desc-text">
<img class="footer-desc-img" src="${url.resourcesPath}/img/logo_text_dd.svg" style=""/>
<p class="footer-desc-par">Aquest és un exemple de personalització de footer al DD.
No editeu aquest fitxer directament, repliqueu el directori dd-custom.sample a dd-custom i trieu el tema dd-custom per 'login' en l'admin de Keycloak.</p>
</div>
<div class="footer-desc-comma">
<img class="footer-desc-logo-comma" src="${url.resourcesPath}/img/dd_coma.svg" style=""/>
</div>
</div>
<div class="footer-links">
<div class="footer-links-item">
<img class="footer-desc-logo-comma-bullet" src="${url.resourcesPath}/img/dd_coma.svg" width="10"><a href="https://www.gnu.org/licenses/agpl-3.0.en.html" target="_blank">Leina DD té una llicència AGPLv3</a>
</div>
<div class="footer-links-item">
<img class="footer-desc-logo-comma-bullet" src="${url.resourcesPath}/img/dd_coma.svg" width="10"/><a href="https://gitlab.com/DD-workspace/DD" target="_blank">Repositori DD a GitLab</a>
</div>
<div class="footer-links-item">
<img class="footer-desc-logo-comma-bullet" src="${url.resourcesPath}/img/dd_coma.svg" width="10"/><a href="https://xnet-x.net/ca/digital-democratic/" target="_blank">Web Pla de Digitalització Democràtica</a>
</div>
<div class="footer-links-policies">
<a href="https://admin.${properties.ddDomain}/legal_text?lang=ca" target="_blank">Avís legal del centre</a>
</div>
</div>
</div>
</footer>

View File

@ -0,0 +1 @@
parent=dd

26
docs/customising.ca.md Normal file
View File

@ -0,0 +1,26 @@
# Personalitzacions
## Peu de pàgina en el login
El peu de pàgina fa part del tema de login de Keycloak, per tal de modificar-lo,
cal fer servir un tema amb base 'dd'.
Per facilitar-lo, al directori `dd-sso/docker/keycloak/themes` trobem:
- `dd-custom`: un directori buit, el que posem aquí Keycloak ho interpretarà
com un nou tema `dd-custom`.
- `dd-custom.sample`: un exemple de com es prepararia el tema `dd-custom`, per
tal de reemplaçar el footer.
Així doncs, per personalitzar el footer, copiarem el contingut de
`dd-custom.sample` a `dd-custom`, i editem `dd-custom/login/dd-footer.ftl`
d'acord amb les nostres necessitats.
Un cop fet això, a la interfície d'administració de Keycloak haurem de triar
`dd-custom` com a tema d'inici de sessió a:
`https://sso.DOMINI/auth/admin/master/console/#/realms/master/theme-settings`
> **Nota:** el directori dd-custom no s'actualitzarà mai, és responsabilitat
> vostra revisar els canvis al tema `dd` i al directori `dd-custom.sample`
> per tal de mantenir la compatibilitat amb els vostres canvis.

View File

@ -50,6 +50,7 @@ nav:
- index.ca.md - index.ca.md
- index.es.md - index.es.md
- install.ca.md - install.ca.md
- customising.ca.md
- post-install.ca.md - post-install.ca.md
- contributing.ca.md - contributing.ca.md
- project-management.md - project-management.md