Migration von Benutzernamen

​

Migration von Benutzernamen

Aus Sicht der Anmeldung ist die E-Mail-Adresse die primäre Kennung eines Benutzers. Wenn Sie von lokaler Authentifizierung auf SSO oder von einem IdP zu einem anderen migrieren, müssen Sie möglicherweise die E-Mail-Adressen der Benutzer aktualisieren.

Dafür steht ein Skript zur Verfügung, das Benutzer-E-Mail-Adressen anhand einer CSV-Datei im folgenden Format migriert:

oldEmail,newEmail

Nach einigen Validierungsprüfungen durchläuft das Skript die CSV-Datei und aktualisiert die E-Mail-Adressen der Benutzer von oldEmail auf newEmail.

​

Validierung

Vor der Migration wird die <csv_file> darauf geprüft, dass:

• in jeder Zeile sowohl oldEmail als auch newEmail gültige E-Mail-Adressen sind
• keine doppelten Einträge vorhanden sind, Sie also beispielsweise nicht versuchen, verschiedene Benutzer auf dieselbe neue E-Mail-Adresse zu aktualisieren oder dasselbe Benutzerkonto mit einer bereits verwendeten E-Mail-Adresse zu aktualisieren

​

Verwendung

docker cp <csv_file> sharelatex:/overleaf/services/web/<csv_file> docker exec sharelatex /bin/bash -c "cd /overleaf/services/web;node ./modules/server-ce-scripts/scripts/migrate-user-emails.js [--commit] [--continue|--ignore-missing] [--admin-id=ADMIN_USER_ID] <csv_file>"

​

Flags

Name	Beschreibung
--commit	Mit dem Flag --commit wird die Migration tatsächlich durchgeführt. Wird es weggelassen, läuft die Migration im Probelaufmodus (Dry Run), in dem keine Änderungen vorgenommen werden, die Validierung aber trotzdem stattfindet. Standard:false
--continue	Mit dem Flag --continue wird der Migrationsprozess fortgesetzt, wenn die E-Mail-Adresse eines Benutzerkontos bereits aktualisiert wurde
--ignore-missing	Mit dem Flag --ignore-missing wird der Migrationsprozess fortgesetzt, wenn ein Benutzerkonto nicht gefunden wurde
--admin-id	--admin-id sollte auf die ID des Administrators gesetzt werden, der die Migration durchführt; sie wird für Einträge im Audit-Log verwendet. Gehen Sie zu Admin > Manage Users, suchen Sie nach Ihrer E-Mail-Adresse und klicken Sie auf das erste Ergebnis, um Ihre Benutzer-ID zu finden.
<csv_file>	<csv_file> ist die Datei mit den alten und neuen E-Mail-Adressen

​

Abschluss

Während der Ausführung des Migrationsskripts hängt es von den gewählten Flags ab, ob ein Fehler in der Konsole protokolliert und dann fortgefahren oder ob er protokolliert und das Skript beendet wird. Wird das Skript aufgrund eines Fehlers vorzeitig beendet, endet es mit Exit-Code 1, um anzuzeigen, dass es nicht erfolgreich war.

Nach Abschluss der Migration gibt das Skript die Anzahl der erfolgreichen, fehlgeschlagenen und übersprungenen Aktualisierungen in der Konsole aus. Wird die Migration erfolgreich abgeschlossen, endet es mit Exit-Code 0.