Keycloak: Uw thema is klaar om te bewerken

Deze documentatie maakt deel uit van de Pas het uiterlijk aan-gids. Bekijk de volledige gids hier: Brand eenvoudig uw Keycloak inlogpagina's, accountconsole en e-mails op Stackhero: stel uw kleuren, logo, teksten in en maak zelfs volledig aangepaste thema's met de ingebouwde online editor..

👋 Welkom bij de Stackhero-documentatie!

Stackhero biedt een Keycloak cloud dienst waarmee u in slechts 2 minuten een productieklare identity provider kunt uitrollen:

  • Onbeperkt aantal gebruikers, realms en clients
  • Ondersteunt OpenID Connect, OAuth 2.0, SAML 2.0, social login, LDAP en Active Directory-federatie
  • Eigen domeinnaam met ingebouwde HTTPS voor veilige toegang (bijvoorbeeld https://login.uw-bedrijf.com)
  • Aangepaste thema's: pas eenvoudig uw loginpagina's, accountconsole en e-mails aan met de meegeleverde online editor
  • Toegewijde mailserver met SPF, DKIM en DMARC, zodat accountbevestigingen en wachtwoordresets automatisch voor u worden afgehandeld
  • Ingebouwde PostgreSQL-database, met de beheerdersconsole beschikbaar op een eigen afsluitbare poort
  • One-click updates houden uw systeem up-to-date zonder handmatige tussenkomst

Besteed uw tijd aan ontwikkelen, niet aan configureren: u kunt Stackhero's Keycloak cloudoplossing in minder dan 5 minuten uitproberen.

Open themes/ en u vindt een default/-map. Dit is uw actieve thema, al in gebruik door uw Keycloak-instantie. U hoeft niets te selecteren: bewerk gewoon de bestanden en zie uw wijzigingen direct terug.

U hoeft geen voorkennis van Keycloak-thema's te hebben. Elk bestand bevat al veelgebruikte instellingen die u kunt aanpassen, met de huidige Keycloak-waarde als uitgecommentarieerd voorbeeld. Om een waarde te wijzigen, verwijdert u het commentaarteken, past u de waarde aan en slaat u op.

Als een regel uitgecommentarieerd blijft, gebruikt Keycloak de standaardwaarde. Zo blijft uw service altijd overeenkomen met het standaard Keycloak-gedrag, ook na updates.

Wat wilt u aanpassenBewerk dit bestand
Kleuren, logo, achtergrond, login-lettertypedefault/login/resources/css/stackhero.css
Teksten op de inlogpaginadefault/login/messages/messages_en.properties
Onderwerpen en inhoud van e-mailsdefault/email/messages/messages_en.properties
Licht of donker themadefault/login/theme.properties
Logo voor account/admin consolesdefault/account/theme.properties, default/admin/theme.properties
HTML-structuur van de inlogpaginaKopieer het .ftl-bestand uit Keycloak naar default/login/ en bewerk het

Open default/login/resources/img/. Hier ziet u de twee afbeeldingen die momenteel op uw inlogpagina worden gebruikt. Upload uw eigen logo met dezelfde bestandsnaam, keycloak-logo-text.svg, en ververs de inlogpagina met Ctrl+F5 (Cmd+Shift+R op macOS).

Dat is alles. U hoeft geen bestanden te bewerken of uw service te herstarten: de update wordt direct toegepast zodra u opslaat. Om de achtergrondafbeelding te wijzigen, vervangt u keycloak-bg-darken.svg in dezelfde map.

Wilt u andere bestandsnamen gebruiken, pas dan de verwijzingen aan in default/login/resources/css/stackhero.css onder het gedeelte "Your logo".

In stackhero.css vindt u variabelen die al zijn ingevuld met hun huidige waarden:

:root {
  /* ---------- Colors ---------- */
  /* The buttons */
  /* --pf-v5-global--primary-color--100: #06c; */
  /* The buttons, while hovered */
  /* --pf-v5-global--primary-color--200: #004080; */
  /* The links */
  /* --pf-v5-global--link--Color: #06c; */
  /* The colored line on top of the login box */
  /* --keycloak-card-top-color: #06c; */

Om een wijziging toe te passen, verwijdert u de commentaartekens, stelt u uw kleur in, slaat u op en laadt u de pagina opnieuw. Dat is alles.

Tijdens het aanpassen: Uw browser cachet de thema-CSS, afbeeldingen en scripts voor één uur. Wanneer u aanpassingen test, herlaad altijd met Ctrl+F5 om uw laatste wijzigingen te zien. Uw bezoekers zien de update binnen een uur.

U heeft volledige controle: het bestand is gewone CSS en wordt als laatste geladen, zodat u elke stijl kunt overschrijven. Gebruik de DevTools van uw browser (F12) om elementen te inspecteren. Keycloak 26 gebruikt het PatternFly design system, dus de meeste kleurvariabelen heten --pf-v5-global--* en kunnen in :root worden overschreven.

Hiervoor hoeft u geen thema te bewerken. Open in uw beheerconsole Realm settings > General en stel de Display name in. Deze naam verschijnt op inlogpagina's en in e-mails.

U kunt teksten aanpassen zonder CSS of HTML te wijzigen. In default/login/messages/messages_en.properties vindt u alle teksten van het inlogformulier met hun standaardformulering. Om een regel te wijzigen, verwijdert u de #, schrijft u uw eigen tekst en slaat u op:

loginAccountTitle=Sign in to Acme
doLogIn=Sign in
doForgotPassword=I forgot my password

Voeg bestanden toe zoals messages_fr.properties voor Frans of messages_de.properties voor Duits, en schakel deze talen vervolgens in via de beheerconsole onder Realm settings > Localization.

Tip: Het tabblad Localization heeft ook een sectie Realm overrides, waarmee u teksten direct in de console kunt aanpassen: geen bestandsbewerking of herstart nodig. Gebruik de methode die het beste bij uw workflow past.

Keycloak verstuurt e-mails voor adresbevestiging, wachtwoordherstel en gebruikersuitnodigingen. In default/email/messages/messages_en.properties vindt u de standaard onderwerpregels en berichten die u kunt aanpassen:

emailVerificationSubject=Confirm your Acme account
passwordResetSubject=Reset your Acme password

Let bij het bewerken van e-mailberichten op het volgende:

  • Behoud de {0}, {1}, {2} placeholders (Keycloak vult deze in met de link, weergavenaam en tijdslimiet).
  • Escape apostrofs door er twee te schrijven (don''t).

Wilt u de HTML van e-mails aanpassen, kopieer dan de gewenste template uit het Keycloak base email theme naar default/email/html/ en bewerk uw kopie.

Stackhero configureert e-mailaflevering voor u met SPF, DKIM en DMARC ingesteld. Stel dit in via Realm settings > Email met de host en poort die op uw servicepagina staan.

Gaat er iets mis, dan kunt u de hele default-map verwijderen en uw service herstarten. Stackhero maakt dan een nieuw standaardthema aan, waarmee het standaard Keycloak-uiterlijk wordt hersteld.

Uw realms, gebruikers en clients staan in uw database en blijven onaangetast.