Міграція імен користувачів

​

Міграція імен користувачів

З погляду входу в систему основним ідентифікатором користувача є його адреса електронної пошти. Якщо ви переходите з локальної автентифікації на SSO або з одного IdP на інший, вам може знадобитися оновити адреси електронної пошти користувачів.

Для цього надається скрипт, який мігрує адреси електронної пошти користувачів за допомогою CSV-файлу такого формату:

oldEmail,newEmail

Після виконання кількох перевірок скрипт пройде CSV-файлом і оновить адреси електронної пошти користувачів з oldEmail на newEmail.

​

Перевірка

Перед запуском міграції <csv_file> буде перевірено, щоб переконатися, що:

• У кожному рядку і oldEmail, і newEmail є дійсними адресами електронної пошти
• Немає дублікатів, наприклад, ви не намагаєтеся змінити адреси різних користувачів на ту саму нову адресу або оновити той самий обліковий запис уже використаною адресою електронної пошти

​

Використання

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

​

Прапорці

Назва	Опис
--commit	Додавання прапорця --commit фактично виконує міграцію. Якщо його не вказано, міграція виконується в пробному режимі (dry-run), у якому зміни не вносяться, але перевірка все одно виконується. За замовчуванням:false
--continue	Прапорець --continue продовжить процес міграції, якщо адресу електронної пошти облікового запису користувача вже було оновлено
--ignore-missing	Прапорець --ignore-missing продовжить процес міграції, якщо обліковий запис користувача не знайдено
--admin-id	Для --admin-id слід вказати ID адміністратора, який виконує міграцію; його буде використано в записах журналу аудиту. Щоб дізнатися свій user-id, перейдіть до Admin > Manage Users, знайдіть свою адресу електронної пошти та натисніть перший результат.
<csv_file>	<csv_file> — це файл зі старими та новими адресами електронної пошти

​

Завершення

Під час виконання скрипту міграції від вибраних прапорців залежить, чи буде помилку записано в консоль із подальшим продовженням роботи, чи записано в консоль із завершенням роботи. Якщо скрипт передчасно завершується через помилку, він виходить із кодом 1, що означає невдале виконання.

Після завершення міграції скрипт виведе в консоль кількість успішних, невдалих і пропущених оновлень. Якщо міграцію завершено успішно, скрипт вийде з кодом 0.