Migration zu LDAP oder SAML

{
  _id:        '123',
  email:      '[e-mail]'
  first_name: 'Alice',
  last_name:  'Jones'
}

Nun möchten Sie das LDAP-/Active-Directory-System Ihres Unternehmens anbinden. In diesem System lauten Alices Daten:

Alice:
  - uid:  'alicejones'
  - mail: '[e-mail]'
  - givenName:   'Alice'
  - sn: 'Jones'

Ihr Ziel ist, dass Alice sich mit ihrem LDAP-Benutzernamen (alicejones) und Passwort statt mit ihren alten Overleaf-Zugangsdaten anmeldet, ohne dabei Arbeit zu verlieren. So erreichen Sie das.

Bei diesem Vorgang muss der Container sharelatex neu erstellt werden, was zu einer gewissen Ausfallzeit führt. Wir empfehlen dringend, sich zunächst in einer Test-/Staging-Umgebung mit diesem Vorgang vertraut zu machen.

1. Bitten Sie Ihre Benutzer, ihre E-Mail-Adressen zu aktualisieren

   Overleaf-Konten sind an E-Mail-Adressen gebunden. Im ersten Schritt müssen Sie daher die Overleaf-E-Mail-Adressen Ihrer Benutzer mit ihren LDAP- bzw. SAML-E-Mail-Adressen abgleichen.

   In unserem Beispiel bitten Sie Alice, sich bei ihrem Overleaf-Konto anzumelden und ihre E-Mail-Adresse von [e-mail] auf [e-mail] zu ändern.

   Vergessen Sie sich selbst nicht! Als Administrator müssen Sie auch Ihre eigene E-Mail-Adresse aktualisieren.

   Wenn Sie viele Benutzer haben, können Sie mit dem Skript zur Benutzernamen-Migration die primäre E-Mail-Adresse von Benutzern in großem Umfang ändern.

2. LDAP- oder SAML-Modul aktivieren

   Sobald alle E-Mail-Adressen aktualisiert sind, ist es Zeit für die Umstellung! Setzen Sie die passenden Umgebungsvariablen für Ihre neue Authentifizierungsmethode und erstellen Sie den Container sharelatex anschließend mit dem Befehl bin/up -d neu.

   Dadurch wird das standardmäßige Overleaf-Anmeldeformular durch Ihr neues LDAP- bzw. SAML-Formular ersetzt.

   Die relevanten Informationen zum Aktivieren von LDAP finden Sie hier und zu SAML 2.0 hier.

3. Benutzer können sich jetzt über LDAP oder SAML anmelden

   Wenn Alice sich das nächste Mal anmeldet, sieht sie das neue Formular.

   

   Sie kann ihren LDAP-Benutzernamen (alicejones) und ihr Passwort eingeben, und da ihre E-Mail-Adresse nun mit der in LDAP übereinstimmt, wird sie direkt in ihrem bestehenden Overleaf-Konto angemeldet. Alle ihre Projekte befinden sich genau dort, wo sie sie verlassen hat.

   Wenn Sie SAML 2.0 aktiviert haben, sehen Benutzer eine Schaltfläche, die sie beim Anklicken zu Ihrem IdP weiterleitet, um dort ihre Zugangsdaten einzugeben. Nach erfolgreicher Authentifizierung werden sie zu Ihrer Overleaf-Instanz zurückgeleitet und in ihrem Konto angemeldet.

   

   Informationen zur Anpassung der Anmeldeseite finden Sie auf der Seite Umgebungsvariablen.

   Und falls Sie jemals zurückwechseln müssen, kommentieren Sie einfach die LDAP-/SAML-Konfiguration aus und erstellen Sie den Container sharelatex mit dem Befehl bin/up -d neu. Benutzer können sich dann mit ihrer aktuellen E-Mail-Adresse und ihrem Overleaf-spezifischen Passwort anmelden.

​

Der umgekehrte Weg: Von LDAP/SAML zurück zur nativen Authentifizierung

Was, wenn Sie LDAP oder SAML schon eine Weile verwenden und zum integrierten Anmeldesystem von Overleaf wechseln möchten (etwa weil Sie Ihr LDAP abgeschaltet haben)? Kein Problem! So gelingt der Wechsel.

1. Prüfen Sie, ob alle E-Mail-Adressen korrekt sind

   Die Konten Ihrer Benutzer sind bereits mit ihren LDAP- bzw. SAML-E-Mail-Adressen verknüpft. Mit dieser E-Mail-Adresse melden sie sich künftig an, also stellen Sie einfach sicher, dass alles stimmt.

2. LDAP- oder SAML-Modul deaktivieren

   Entfernen Sie einfach die LDAP-/SAML-Konfigurationseinstellungen oder heben Sie sie auf, und erstellen Sie den Container sharelatex mit dem Befehl bin/up -d neu. Dadurch wird das native Overleaf-Anmeldeformular mit E-Mail und Passwort wiederhergestellt.

   
3. Bitten Sie die Benutzer, ihre Passwörter zurückzusetzen

   Wenn Ihre Benutzer jetzt die Anmeldeseite aufrufen, sehen sie das Overleaf-Anmeldeformular statt des LDAP-/SAML-Formulars.

   Da sie möglicherweise nie ein natives Overleaf-Passwort hatten, müssen sie eines erstellen. Jeder Benutzer sollte:

   • Auf den Link „Forgot your password?” klicken.
   • Die mit seinem Konto verknüpfte E-Mail-Adresse eingeben (die aus LDAP/SAML).
   • Dem Link in der E-Mail zum Zurücksetzen des Passworts folgen, um ein neues Passwort festzulegen.

   Falls noch nicht geschehen, lesen Sie unsere Anleitung zum Aktivieren der E-Mail-Zustellung.

   Danach können sie sich mit ihrer E-Mail-Adresse und ihrem neuen Overleaf-spezifischen Passwort anmelden und auf alle ihre Projekte zugreifen.