Переход на LDAP или SAML

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

Теперь вы хотите интегрироваться с системой LDAP/Active Directory вашей компании. В этой системе данные Алисы следующие:

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

Ваша цель — чтобы Алиса входила в систему с помощью своего имени пользователя LDAP (alicejones) и пароля вместо старых учётных данных Overleaf, не потеряв при этом свою работу. Вот как этого добиться.

Этот процесс потребует пересоздания контейнера sharelatex, что приведёт к некоторому простою. Настоятельно рекомендуем сначала ознакомиться с процессом, пройдя его в тестовой/промежуточной среде.

1. Попросите пользователей обновить адреса электронной почты

   Учётные записи Overleaf привязаны к адресам электронной почты, поэтому первый шаг — синхронизировать адреса электронной почты пользователей в Overleaf с их адресами в LDAP или SAML.

   В нашем примере нужно попросить Алису войти в свою учётную запись Overleaf и изменить адрес электронной почты с [e-mail] на [e-mail].

   Не забудьте о себе! Если вы администратор, вам также нужно обновить свой адрес электронной почты.

   Если у вас много пользователей, можно воспользоваться скриптом Username migration, чтобы массово изменить основные адреса электронной почты пользователей.

2. Включите модуль LDAP или SAML

   Когда адреса электронной почты у всех обновлены, пора переключаться! Задайте нужные переменные окружения для нового метода аутентификации, а затем пересоздайте контейнер sharelatex с помощью команды bin/up -d.

   Это заменит стандартную форму входа Overleaf новой формой LDAP или SAML.

   Информацию о включении LDAP можно найти здесь, а о SAML 2.0 — здесь.

3. Теперь пользователи могут входить через LDAP или SAML

   При следующем входе Алиса увидит новую форму.

   

   Она может ввести своё имя пользователя LDAP (alicejones) и пароль, и поскольку её адрес электронной почты теперь совпадает с адресом в LDAP, она сразу войдёт в свою существующую учётную запись Overleaf. Все её проекты останутся на своих местах.

   Если вы включили SAML 2.0, пользователи увидят кнопку, при нажатии на которую они будут перенаправлены к вашему IdP для ввода учётных данных. После успешной аутентификации они будут перенаправлены обратно в ваш экземпляр Overleaf и войдут в свою учётную запись.

   

   Сведения о настройке страницы входа см. на странице Environment Variables.

   Если когда-либо потребуется откат, просто закомментируйте конфигурацию LDAP/SAML и пересоздайте контейнер sharelatex с помощью команды bin/up -d. После этого пользователи смогут входить, используя текущий адрес электронной почты и пароль Overleaf.

​

Обратный путь: переход с LDAP/SAML обратно на встроенную аутентификацию

Что если вы какое-то время использовали LDAP или SAML и хотите перейти на встроенную систему входа Overleaf (например, вы отказались от LDAP)? Без проблем! Вот как выполнить такой переход.

1. Проверьте правильность адресов электронной почты

   Учётные записи ваших пользователей уже привязаны к их адресам электронной почты из LDAP или SAML. Именно этот адрес они будут использовать для входа в дальнейшем, поэтому просто убедитесь, что всё указано правильно.

2. Отключите модуль LDAP или SAML

   Просто удалите или сбросьте параметры конфигурации LDAP/SAML и пересоздайте контейнер sharelatex с помощью команды bin/up -d. Это вернёт встроенную форму входа Overleaf по адресу электронной почты и паролю.

   
3. Попросите пользователей сбросить пароли

   Теперь при посещении страницы входа пользователи увидят форму входа Overleaf вместо формы LDAP/SAML.

   Поскольку у них, возможно, никогда не было собственного пароля Overleaf, им потребуется его создать. Каждый пользователь должен:

   • Нажать ссылку «Forgot your password?».
   • Ввести адрес электронной почты, связанный с учётной записью (тот, что был в LDAP/SAML).
   • Перейти по ссылке в письме для сброса пароля и задать новый пароль.

   Если вы ещё этого не сделали, ознакомьтесь с нашим руководством по включению доставки электронной почты.

   После этого они смогут входить с помощью своего адреса электронной почты и нового пароля Overleaf и получат доступ ко всем своим проектам.