Migracja do LDAP lub SAML

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

Teraz chcesz zintegrować się z firmowym systemem LDAP/Active Directory. W tym systemie dane Alice wyglądają następująco:

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

Twoim celem jest umożliwienie Alice logowania się za pomocą nazwy użytkownika LDAP (alicejones) i hasła zamiast dotychczasowych danych logowania Overleaf, bez utraty jakiejkolwiek jej pracy. Oto jak to zrobić.

Ten proces wymaga odtworzenia kontenera sharelatex, co spowoduje pewien przestój. Zdecydowanie zalecamy, aby najpierw zapoznać się z tym procesem, przeprowadzając go w środowisku testowym/przedprodukcyjnym.

1. Poproś użytkowników o zaktualizowanie adresów e-mail

   Konta Overleaf są powiązane z adresami e-mail, więc pierwszym krokiem jest zsynchronizowanie adresów e-mail użytkowników w Overleaf z ich adresami e-mail w LDAP lub SAML.

   W naszym przykładzie poprosiłbyś Alice, aby zalogowała się na swoje konto Overleaf i zmieniła adres e-mail z [e-mail] na [e-mail].

   Nie zapomnij o sobie! Jeśli jesteś administratorem, musisz również zaktualizować własny adres e-mail.

   Jeśli masz wielu użytkowników, możesz użyć skryptu Username migration, aby zbiorczo zmienić główne adresy e-mail użytkowników.

2. Włącz moduł LDAP lub SAML

   Gdy adresy e-mail wszystkich użytkowników zostaną zaktualizowane, czas przełączyć przełącznik! Musisz ustawić odpowiednie zmienne środowiskowe dla nowej metody uwierzytelniania, a następnie odtworzyć kontener sharelatex za pomocą polecenia bin/up -d.

   Spowoduje to zastąpienie standardowego formularza logowania Overleaf nowym formularzem LDAP lub SAML.

   Informacje o włączaniu LDAP znajdziesz tutaj, a o SAML 2.0 tutaj.

3. Użytkownicy mogą teraz logować się przez LDAP lub SAML

   Przy następnym logowaniu Alice zobaczy nowy formularz.

   

   Może wpisać swoją nazwę użytkownika LDAP (alicejones) i hasło, a ponieważ jej adres e-mail jest teraz zgodny z adresem w LDAP, zostanie zalogowana bezpośrednio na swoje istniejące konto Overleaf. Wszystkie jej projekty będą dokładnie tam, gdzie je zostawiła.

   Jeśli włączono SAML 2.0, użytkownicy zobaczą przycisk, który po kliknięciu przekieruje ich do Twojego IdP w celu wprowadzenia danych logowania. Po pomyślnym uwierzytelnieniu zostaną przekierowani z powrotem do instancji Overleaf i zalogowani na swoje konto.

   

   Informacje o dostosowywaniu strony logowania znajdziesz na stronie Zmienne środowiskowe.

   Jeśli kiedykolwiek będziesz musiał wycofać zmiany, wystarczy zakomentować konfigurację LDAP/SAML i odtworzyć kontener sharelatex za pomocą polecenia bin/up -d. Użytkownicy będą wtedy mogli logować się za pomocą bieżącego adresu e-mail i hasła Overleaf.

​

Droga powrotna: przełączenie z LDAP/SAML z powrotem na natywne uwierzytelnianie

Co jeśli przez jakiś czas korzystałeś z LDAP lub SAML i chcesz przejść na wbudowany system logowania Overleaf (np. dlatego, że wycofałeś LDAP)? Żaden problem! Oto jak przeprowadzić takie przełączenie.

1. Sprawdź, czy adresy e-mail wszystkich użytkowników są poprawne

   Konta użytkowników są już powiązane z ich adresami e-mail z LDAP lub SAML. Tych adresów będą odtąd używać do logowania, więc po prostu upewnij się, że wszystko się zgadza.

2. Wyłącz moduł LDAP lub SAML

   Po prostu usuń lub wyczyść ustawienia konfiguracji LDAP/SAML i odtwórz kontener sharelatex za pomocą polecenia bin/up -d. Przywróci to natywny formularz logowania Overleaf z adresem e-mail i hasłem.

   
3. Poproś użytkowników o zresetowanie haseł

   Gdy użytkownicy odwiedzą teraz stronę logowania, zobaczą formularz logowania Overleaf zamiast formularza LDAP/SAML.

   Ponieważ mogli nigdy nie mieć natywnego hasła Overleaf, będą musieli je utworzyć. Każdy użytkownik powinien:

   • Kliknąć link „Forgot your password?”.
   • Wprowadzić adres e-mail powiązany z kontem (ten z LDAP/SAML).
   • Kliknąć link w wiadomości e-mail dotyczącej resetowania hasła i ustawić nowe hasło.

   Jeśli jeszcze tego nie zrobiłeś, zapoznaj się z naszym poradnikiem dotyczącym włączania wysyłania wiadomości e-mail.

   Po wykonaniu tych czynności użytkownicy mogą logować się za pomocą adresu e-mail i nowego hasła Overleaf, uzyskując dostęp do wszystkich swoich projektów.