Migratie van gebruikersnamen

​

Migratie van gebruikersnamen

Vanuit het oogpunt van inloggen is het e-mailadres de primaire identificatie van een gebruiker. Als je migreert van lokale authenticatie naar SSO of van de ene IdP naar de andere, moet je mogelijk de e-mailadressen van gebruikers bijwerken.

Om hierbij te helpen is er een script beschikbaar dat e-mailadressen van gebruikers migreert met behulp van een CSV-bestand met de volgende indeling:

oldEmail,newEmail

Na het uitvoeren van enkele validatiecontroles doorloopt het script het CSV-bestand en werkt het de e-mailadressen van de gebruikers bij van oldEmail naar newEmail.

​

Validatie

Voordat de migratie wordt uitgevoerd, wordt het <csv_file> gecontroleerd om ervoor te zorgen dat:

• voor elke rij zowel oldEmail als newEmail geldige e-mailadressen zijn
• er geen dubbele vermeldingen zijn, bijvoorbeeld dat je niet probeert verschillende gebruikers naar hetzelfde nieuwe e-mailadres bij te werken, of hetzelfde gebruikersaccount bij te werken met een e-mailadres dat al in gebruik is

​

Gebruik

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>"

​

Vlaggen

Naam	Beschrijving
--commit	Met de vlag --commit wordt de migratie daadwerkelijk uitgevoerd. Als deze wordt weggelaten, vindt de migratie plaats in een dry-run-modus waarbij geen wijzigingen worden aangebracht, maar de validatie wel wordt uitgevoerd. Standaard:false
--continue	Met de vlag --continue gaat het migratieproces door als het e-mailadres van een gebruikersaccount al is bijgewerkt
--ignore-missing	Met de vlag --ignore-missing gaat het migratieproces door als een gebruikersaccount niet is gevonden
--admin-id	--admin-id moet worden ingesteld op het ID van de beheerder die de migratie uitvoert en wordt gebruikt voor vermeldingen in het auditlogboek. Ga naar Admin > Manage Users, zoek op je e-mailadres en klik op het eerste resultaat om je user-id te vinden.
<csv_file>	<csv_file> is het bestand met de oude en nieuwe e-mailadressen

​

Afronding

Tijdens het uitvoeren van het migratiescript bepalen de gekozen vlaggen of een fout naar de console wordt gelogd waarna het script doorgaat, of naar de console wordt gelogd waarna het script stopt. Als het script voortijdig wordt beëindigd door een fout, sluit het af met code 1 om aan te geven dat het niet is gelukt.

Na voltooiing van de migratie logt het script het aantal geslaagde, mislukte en overgeslagen updates naar de console. Als de migratie succesvol is voltooid, sluit het af met code 0.