Migracja nazw użytkowników

​

Migracja nazw użytkowników

Z punktu widzenia logowania podstawowym identyfikatorem użytkownika jest jego adres e-mail. Jeśli przechodzisz z lokalnego uwierzytelniania na SSO lub migrujesz z jednego IdP do innego, może być konieczna aktualizacja adresów e-mail użytkowników.

Aby to ułatwić, udostępniono skrypt, który migruje adresy e-mail użytkowników na podstawie pliku CSV w następującym formacie:

oldEmail,newEmail

Po wykonaniu kilku kontroli poprawności skrypt przechodzi przez plik CSV i aktualizuje adresy e-mail użytkowników z oldEmail na newEmail.

​

Walidacja

Przed uruchomieniem migracji plik <csv_file> zostanie sprawdzony, aby upewnić się, że:

• W każdym wierszu zarówno oldEmail, jak i newEmail są prawidłowymi adresami e-mail
• Nie ma zduplikowanych wpisów, na przykład nie próbujesz zmienić adresów różnych użytkowników na ten sam nowy adres e-mail ani przypisać do tego samego konta użytkownika adresu, który jest już w użyciu

​

Użycie

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

​

Flagi

Nazwa	Opis
--commit	Dodanie flagi --commit faktycznie przeprowadza migrację. Bez niej migracja odbywa się w trybie próbnym (dry-run), w którym nie są wprowadzane żadne zmiany, ale walidacja jest nadal wykonywana. Domyślnie:false
--continue	Flaga --continue kontynuuje proces migracji, jeśli adres e-mail na koncie użytkownika został już zaktualizowany
--ignore-missing	Flaga --ignore-missing kontynuuje proces migracji, jeśli nie znaleziono konta użytkownika
--admin-id	--admin-id należy ustawić na identyfikator administratora przeprowadzającego migrację; będzie on używany we wpisach dziennika audytu. Aby znaleźć swój identyfikator użytkownika, przejdź do Admin > Manage Users, wyszukaj swój adres e-mail i kliknij pierwszy wynik.
<csv_file>	<csv_file> to plik zawierający stare i nowe adresy e-mail

​

Zakończenie

Podczas wykonywania skryptu migracji od wybranych flag zależy, czy błąd zostanie zapisany w konsoli, a skrypt będzie kontynuował działanie, czy też błąd zostanie zapisany w konsoli, a skrypt zakończy działanie. Jeśli skrypt zakończy się przedwcześnie z powodu błędu, zwróci kod wyjścia 1, sygnalizujący niepowodzenie.

Po zakończeniu migracji skrypt wypisze w konsoli liczbę udanych, nieudanych i pominiętych aktualizacji. Jeśli migracja zakończy się pomyślnie, skrypt zwróci kod wyjścia 0.