Erste Schritte mit Skycloak

Willkommen bei Skycloak! Diese Anleitung begleitet Sie bei der ersten Anmeldung und durch das Onboarding und zeigt, wie Sie das Beste aus Ihrer verwalteten Keycloak-Plattform holen. In wenigen Minuten ist Ihr Workspace für eine sichere Identitätsverwaltung bereit.

Ihre erste Anmeldung

Konto anlegen

Wenn Sie sich zum ersten Mal bei Skycloak registrieren:

1. Öffnen Sie skycloak.io und klicken Sie auf „Start Free Trial“ (kostenlose Testphase starten)
2. Wählen Sie Ihre Registrierungsmethode:
   • E-Mail und Passwort
   • Google OAuth
   • GitHub OAuth
3. Bestätigen Sie Ihre E-Mail-Adresse (bei Registrierung per E-Mail)
4. Wählen Sie Ihren Onboarding-Weg auf dem Willkommensbildschirm

Das Onboarding

Nach der Registrierung landen Sie auf einem Willkommensbildschirm mit drei Wegen zur Auswahl. Nehmen Sie den, der zu Ihrem Einstieg passt, alle enden auf demselben Dashboard.

Die angebotenen Wege richten sich nach Ihrem Konto, und Sie können jederzeit über den Link „Skip, set it up myself“ (überspringen, ich richte es selbst ein) am unteren Rand aussteigen, der Sie direkt auf den Instanz-Weg bringt.

Ihre gehostete Anmeldeseite gestalten

Oben auf dem Willkommensbildschirm bietet Skycloak an, Ihre gehostete Anmeldeseite zu personalisieren. Gehört Ihre E-Mail-Adresse zu einer Firmendomain, erkennen wir das; in jedem Fall können Sie Ihr Logo direkt hochladen oder auf Skip branding (Gestaltung überspringen) klicken und es später auf der Seite Branding nachholen.

Weg 1: Sign-in for my app’s users (etwa 3 Minuten)

Der schnellste Weg, eine Anmeldung in eine Anwendung einzubauen, die Sie gerade entwickeln:

1. Wählen Sie Ihr Framework aus einem durchsuchbaren Raster: React, Angular, Vue, Next.js, Nuxt, SvelteKit, Node.js, Django, Spring Boot, .NET Core, FastAPI, Express, Laravel, Rails, Flask, WordPress, Drupal und viele weitere. Jede Karte führt zur vollständigen Integrationsanleitung.
2. Sie nutzen etwas anderes? Wählen Sie die Karte Other / Not listed (anderes, nicht aufgeführt): Skycloak legt einen Client an und gibt Ihnen generische OIDC-Zugangsdaten, die mit jedem OIDC-fähigen Stack funktionieren.
3. Kopieren Sie den Codeausschnitt: Sie erhalten einen vorkonfigurierten OIDC-Client und einen einfügefertigen Ausschnitt für Ihr Framework. Sobald er ausgerollt ist, können sich Benutzer anmelden.

Weg 2: Move my existing Keycloak here (etwa 10 Minuten)

Um ein Keycloak zu übernehmen, das Sie bereits anderswo betreiben:

• Laden Sie einen Datenbank-Dump hoch: Ihre Daten werden unverändert übernommen
• Realms, Clients und Benutzer kommen mit: die bestehende Konfiguration bleibt erhalten
• Bestehende Passwörter funktionieren weiter: Ihre Benutzer müssen nichts zurücksetzen

Die ausführliche Anleitung steht unter Migrating from Keycloak (auf Englisch).

Weg 3: New instance, I’ll set it up myself (etwa 4 Minuten)

Für Teams, die Keycloak kennen und eine neue Instanz mit der vollständigen Konsole möchten:

• SSO zur Admin-Konsole: Melden Sie sich mit Ihrem Skycloak-Konto an der Keycloak-Administrationskonsole an, separate Administratorzugangsdaten entfallen
• kcadm- und Terraform-Ausschnitte: einsatzbereite Automatisierungsbeispiele für Ihre Einrichtung per Skript
• Volle Kontrolle über Feature-Flags: Keycloak-Serverfunktionen je Cluster ein- und ausschalten

Suchen Sie SSO für Mitarbeitende?

SSO auf Workspace-Ebene für Ihr eigenes Team (SAML oder OIDC gegen Ihren Identitätsanbieter) wird nach dem Onboarding im Dashboard eingerichtet, siehe Workspace SSO (auf Englisch).

Anlegen des Workspace

Automatische Einrichtung

Parallel zum Onboarding erledigt Skycloak automatisch folgendes:

1. Ihr Workspace wird angelegt, mit einer eindeutigen Kennung
2. Sie werden als Eigentümerin oder Eigentümer des Workspace eingetragen
3. Ihre kostenlose Testphase startet: 21 Tage auf dem App-Weg (ein vollständig verwalteter Realm auf dem Shared Cluster) oder 7 Tage auf dem Expert-Weg (Ihr eigener dedizierter Cluster). Eine Kreditkarte ist nicht nötig, und beide Wege lassen sich verlängern. Endet eine Testphase auf dem Expert-Weg ohne Upgrade, wird der dedizierte Cluster pausiert und 7 Tage später gelöscht. Wir informieren Sie vorher per E-Mail, und ein Upgrade innerhalb dieser Woche stellt alles wieder her.

Nach dem Onboarding: Ihre Cluster-Seite

Nach dem Onboarding landen Sie auf der Cluster-Seite, der Startseite Ihres Workspace. Je nach gewähltem Weg steht dort Ihr verwalteter Realm oder Ihr dedizierter Cluster bereit.

Von hier aus sind das die wichtigsten nächsten Schritte:

1. E-Mail bestätigen: die Adresse Ihres Kontos bestätigen (Voraussetzung für ein Abonnement und für Admin Console SSO)
2. Realm oder Cluster öffnen: hineinklicken, um Zustand, Messwerte in Echtzeit und Konfiguration zu sehen
3. Erste Anwendung erstellen: die Authentifizierung für Ihre App konfigurieren
4. E-Mail-Einstellungen konfigurieren: SMTP für Benachrichtigungen einrichten
5. Teammitglieder einladen: Kolleginnen und Kollegen über die Seite Team hinzufügen

Je nach Tarif können Sie außerdem:

• Eigene Domain hinzufügen: Ihre eigene Domain nutzen (etwa auth.ihrunternehmen.de)
• Erscheinungsbild anpassen: Anmeldeseiten in Ihrem Markendesign gestalten
• Keycloak erweitern: Erweiterungen für zusätzliche Funktionen installieren
• E-Mail-Vorlagen gestalten: Benachrichtigungen anpassen

Onboarding überspringen

Wenn Sie einem bestehenden Workspace per Einladung beitreten:

• Wird das Onboarding automatisch übersprungen
• Landen Sie direkt auf der Cluster-Seite des Workspace
• Ergeben sich Rolle und Berechtigungen aus der Einladung

Für erfahrene Nutzerinnen und Nutzer, die sich neu registrieren:

• Nutzen Sie „Skip onboarding for now“ (vorerst überspringen) oder „Skip, set it up myself“ (überspringen, ich richte es selbst ein) in jedem Onboarding-Schritt außer auf der abschließenden Erfolgsseite
• Ihr Workspace wird trotzdem automatisch angelegt
• Sie erreichen alle Funktionen direkt über die Seitenleiste

Tipps für die Zeit nach dem Onboarding

Lassen Sie sich Zeit

• Zu jedem Schritt der Startcheckliste gibt es eine Anleitung
• Ihr Fortschritt wird automatisch festgehalten
• Sie können die Aufgaben in beliebiger Reihenfolge erledigen (einige bauen aufeinander auf)

Nutzen Sie die Hilfsangebote

• Links zur Dokumentation überall im Dashboard
• E-Mail-Support unter support@skycloak.io
• Kurzhinweise in der Anwendung für häufige Fragen

Gängige Muster

Für Endkundenanwendungen:

1. Beginnen Sie mit sozialer Anmeldung (Google, GitHub und weitere)
2. Ergänzen Sie E-Mail und Passwort als Rückfalloption
3. Aktivieren Sie die Selbstregistrierung

Für B2B-Anwendungen:

1. Richten Sie Unternehmens-SSO nach dem Onboarding im Dashboard ein (Workspace SSO, auf Englisch)
2. Konfigurieren Sie rollenbasierten Zugriff
3. Setzen Sie MFA verbindlich durch

Für interne Werkzeuge:

1. Binden Sie Active Directory oder LDAP an
2. Legen Sie Gruppen für Mitarbeitende an
3. Definieren Sie Zugriffsrichtlinien

Probleme beim Onboarding

Häufige Fälle

1. Keine E-Mail erhalten

   • Spam-Ordner prüfen
   • E-Mail-Adresse überprüfen
   • Erneuten Versand in den Kontoeinstellungen anfordern

2. Workspace wurde nicht angelegt

   • Seite neu laden
   • Netzwerkverbindung prüfen
   • Support kontaktieren, wenn das Problem bleibt

3. Onboarding hängt

   • Browser-Cache leeren
   • Anderen Browser ausprobieren
   • An support@skycloak.io schreiben

4. Meldung „Use a different email address” nach der Registrierung

   • Skycloak akzeptiert für neue Konten keine Wegwerf-E-Mail-Dienste
   • Erneut mit Ihrer geschäftlichen oder privaten E-Mail-Adresse registrieren
   • Wurde Ihre Adresse irrtümlich blockiert, an support@skycloak.io schreiben, wir schalten sie wieder frei

Hilfe erhalten

Während des Onboardings:

• 📧 E-Mail: support@skycloak.io
• 📚 Links zur Dokumentation in jedem Schritt

Nächste Schritte

1. Cluster erstellen:

   • Ersten Cluster erstellen
   • Region und Cluster-Größe wählen

2. Anwendung konfigurieren (Seiten auf Englisch):

   • Authentifizierung einrichten
   • Anmeldeablauf testen

3. Erscheinungsbild anpassen (Seiten auf Englisch):

   • Anmeldeseiten gestalten
   • Eigene Domain einrichten
   • E-Mails konfigurieren

4. Team einladen (Seiten auf Englisch):

   • Teamverwaltung
   • Rollen und Berechtigungen zuweisen

5. Überwachen und optimieren (Seiten auf Englisch):

   • Auswertungen ansehen
   • Ereignisprotokolle prüfen
   • Protokolle beobachten